Skip to content

Remove auto-commit API report workflow #8808

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Mar 3, 2025
Merged

Remove auto-commit API report workflow #8808

merged 6 commits into from
Mar 3, 2025

Conversation

hsubox76
Copy link
Contributor

@hsubox76 hsubox76 commented Feb 24, 2025

update-api-reports.yml would run yarn build and generate API reports (the md files in common/api-review that we use to check if the API surface has changed) in case the contributor forgot to (it would be run if the contributor runs yarn build locally after making any changes but sometimes people forget).

It also commits the changes to the remote branch, which causes some friction because

  1. the contributor's local branch gets out of sync with the remote and they have to make sure to pull before doing anything else on their branch
  2. CI won't run on that commit and all the checks will be waiting indefinitely if the contributor doesn't add any more commits after that

Switched it to the way the docs check works, which is to fail and log a message to run yarn build or yarn docgen:all as is appropriate. (If there are differences found in both common/api-review and docs-devsite, then the suggestion is to run yarn docgen:all as it covers both).

Removed the final message step as the workflow log UI seems to direct you to look straight at the step that failed anyway. Put the messages in the failed step.

Tested api-report changes only and tested with docs changes only, and both seem to work.

Copy link

changeset-bot bot commented Feb 24, 2025

⚠️ No Changeset found

Latest commit: 3c13401

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@google-oss-bot
Copy link
Contributor

google-oss-bot commented Feb 24, 2025

@google-oss-bot
Copy link
Contributor

google-oss-bot commented Feb 24, 2025

@hsubox76 hsubox76 marked this pull request as ready for review February 25, 2025 00:07
@hsubox76 hsubox76 requested a review from a team as a code owner February 25, 2025 00:07
@hsubox76 hsubox76 merged commit 7ae4824 into main Mar 3, 2025
37 checks passed
@hsubox76 hsubox76 deleted the ch-rm-api-workflow branch March 3, 2025 23:23
@firebase firebase locked and limited conversation to collaborators Apr 3, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants